

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>OCC.XSControl module &mdash; pythonocc API 0.18 documentation</title>
  

  
  
  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="static/css/theme.css" type="text/css" />
  

  

  
        <link rel="index" title="Index"
              href="genindex.html"/>
        <link rel="search" title="Search" href="search.html"/>
    <link rel="top" title="pythonocc API 0.18 documentation" href="index.html"/> 

  
  <script src="static/js/modernizr.min.js"></script>

</head>

<body class="wy-body-for-nav" role="document">

   
  <div class="wy-grid-for-nav">

    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> pythonocc API
          

          
          </a>

          
            
            
              <div class="version">
                0.18
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <!-- Local TOC -->
              <div class="local-toc"><ul>
<li><a class="reference internal" href="#">OCC.XSControl module</a></li>
</ul>
</div>
            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">pythonocc API</a>
        
      </nav>


      
      <div class="wy-nav-content">
        <div class="rst-content">
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>OCC.XSControl module</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="sources/OCC.XSControl.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="occ-xscontrol-module">
<h1>OCC.XSControl module<a class="headerlink" href="#occ-xscontrol-module" title="Permalink to this headline">¶</a></h1>
<span class="target" id="module-OCC.XSControl"></span><p>-Purpose : This package provides complements to IFSelect &amp; Co forcontrol of a session</p>
<dl class="class">
<dt id="OCC.XSControl.Handle_XSControl_ConnectedShapes">
<em class="property">class </em><code class="descname">Handle_XSControl_ConnectedShapes</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_ConnectedShapes" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.IFSelect.html#OCC.IFSelect.Handle_IFSelect_SelectExplore" title="OCC.IFSelect.Handle_IFSelect_SelectExplore"><code class="xref py py-class docutils literal"><span class="pre">OCC.IFSelect.Handle_IFSelect_SelectExplore</span></code></a></p>
<dl class="staticmethod">
<dt id="OCC.XSControl.Handle_XSControl_ConnectedShapes.DownCast">
<em class="property">static </em><code class="descname">DownCast</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_ConnectedShapes.DownCast" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_ConnectedShapes.GetObject">
<code class="descname">GetObject</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_ConnectedShapes.GetObject" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_ConnectedShapes.IsNull">
<code class="descname">IsNull</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_ConnectedShapes.IsNull" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_ConnectedShapes.Nullify">
<code class="descname">Nullify</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_ConnectedShapes.Nullify" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.Handle_XSControl_ConnectedShapes.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_ConnectedShapes.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.Handle_XSControl_Controller">
<em class="property">class </em><code class="descname">Handle_XSControl_Controller</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_Controller" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.MMgt.html#OCC.MMgt.Handle_MMgt_TShared" title="OCC.MMgt.Handle_MMgt_TShared"><code class="xref py py-class docutils literal"><span class="pre">OCC.MMgt.Handle_MMgt_TShared</span></code></a></p>
<dl class="staticmethod">
<dt id="OCC.XSControl.Handle_XSControl_Controller.DownCast">
<em class="property">static </em><code class="descname">DownCast</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_Controller.DownCast" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_Controller.GetObject">
<code class="descname">GetObject</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_Controller.GetObject" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_Controller.IsNull">
<code class="descname">IsNull</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_Controller.IsNull" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_Controller.Nullify">
<code class="descname">Nullify</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_Controller.Nullify" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.Handle_XSControl_Controller.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_Controller.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.Handle_XSControl_SelectForTransfer">
<em class="property">class </em><code class="descname">Handle_XSControl_SelectForTransfer</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_SelectForTransfer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.IFSelect.html#OCC.IFSelect.Handle_IFSelect_SelectExtract" title="OCC.IFSelect.Handle_IFSelect_SelectExtract"><code class="xref py py-class docutils literal"><span class="pre">OCC.IFSelect.Handle_IFSelect_SelectExtract</span></code></a></p>
<dl class="staticmethod">
<dt id="OCC.XSControl.Handle_XSControl_SelectForTransfer.DownCast">
<em class="property">static </em><code class="descname">DownCast</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_SelectForTransfer.DownCast" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_SelectForTransfer.GetObject">
<code class="descname">GetObject</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_SelectForTransfer.GetObject" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_SelectForTransfer.IsNull">
<code class="descname">IsNull</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_SelectForTransfer.IsNull" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_SelectForTransfer.Nullify">
<code class="descname">Nullify</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_SelectForTransfer.Nullify" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.Handle_XSControl_SelectForTransfer.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_SelectForTransfer.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.Handle_XSControl_SignTransferStatus">
<em class="property">class </em><code class="descname">Handle_XSControl_SignTransferStatus</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_SignTransferStatus" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.IFSelect.html#OCC.IFSelect.Handle_IFSelect_Signature" title="OCC.IFSelect.Handle_IFSelect_Signature"><code class="xref py py-class docutils literal"><span class="pre">OCC.IFSelect.Handle_IFSelect_Signature</span></code></a></p>
<dl class="staticmethod">
<dt id="OCC.XSControl.Handle_XSControl_SignTransferStatus.DownCast">
<em class="property">static </em><code class="descname">DownCast</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_SignTransferStatus.DownCast" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_SignTransferStatus.GetObject">
<code class="descname">GetObject</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_SignTransferStatus.GetObject" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_SignTransferStatus.IsNull">
<code class="descname">IsNull</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_SignTransferStatus.IsNull" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_SignTransferStatus.Nullify">
<code class="descname">Nullify</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_SignTransferStatus.Nullify" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.Handle_XSControl_SignTransferStatus.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_SignTransferStatus.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.Handle_XSControl_TransferReader">
<em class="property">class </em><code class="descname">Handle_XSControl_TransferReader</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_TransferReader" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.MMgt.html#OCC.MMgt.Handle_MMgt_TShared" title="OCC.MMgt.Handle_MMgt_TShared"><code class="xref py py-class docutils literal"><span class="pre">OCC.MMgt.Handle_MMgt_TShared</span></code></a></p>
<dl class="staticmethod">
<dt id="OCC.XSControl.Handle_XSControl_TransferReader.DownCast">
<em class="property">static </em><code class="descname">DownCast</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_TransferReader.DownCast" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_TransferReader.GetObject">
<code class="descname">GetObject</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_TransferReader.GetObject" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_TransferReader.IsNull">
<code class="descname">IsNull</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_TransferReader.IsNull" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_TransferReader.Nullify">
<code class="descname">Nullify</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_TransferReader.Nullify" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.Handle_XSControl_TransferReader.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_TransferReader.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.Handle_XSControl_TransferWriter">
<em class="property">class </em><code class="descname">Handle_XSControl_TransferWriter</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_TransferWriter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.MMgt.html#OCC.MMgt.Handle_MMgt_TShared" title="OCC.MMgt.Handle_MMgt_TShared"><code class="xref py py-class docutils literal"><span class="pre">OCC.MMgt.Handle_MMgt_TShared</span></code></a></p>
<dl class="staticmethod">
<dt id="OCC.XSControl.Handle_XSControl_TransferWriter.DownCast">
<em class="property">static </em><code class="descname">DownCast</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_TransferWriter.DownCast" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_TransferWriter.GetObject">
<code class="descname">GetObject</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_TransferWriter.GetObject" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_TransferWriter.IsNull">
<code class="descname">IsNull</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_TransferWriter.IsNull" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_TransferWriter.Nullify">
<code class="descname">Nullify</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_TransferWriter.Nullify" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.Handle_XSControl_TransferWriter.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_TransferWriter.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.Handle_XSControl_WorkSession">
<em class="property">class </em><code class="descname">Handle_XSControl_WorkSession</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_WorkSession" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.IFSelect.html#OCC.IFSelect.Handle_IFSelect_WorkSession" title="OCC.IFSelect.Handle_IFSelect_WorkSession"><code class="xref py py-class docutils literal"><span class="pre">OCC.IFSelect.Handle_IFSelect_WorkSession</span></code></a></p>
<dl class="staticmethod">
<dt id="OCC.XSControl.Handle_XSControl_WorkSession.DownCast">
<em class="property">static </em><code class="descname">DownCast</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_WorkSession.DownCast" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_WorkSession.GetObject">
<code class="descname">GetObject</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_WorkSession.GetObject" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_WorkSession.IsNull">
<code class="descname">IsNull</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_WorkSession.IsNull" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.Handle_XSControl_WorkSession.Nullify">
<code class="descname">Nullify</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_WorkSession.Nullify" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.Handle_XSControl_WorkSession.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.Handle_XSControl_WorkSession.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.SwigPyIterator">
<em class="property">class </em><code class="descname">SwigPyIterator</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.SwigPyIterator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<dl class="method">
<dt id="OCC.XSControl.SwigPyIterator.advance">
<code class="descname">advance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.SwigPyIterator.advance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.SwigPyIterator.copy">
<code class="descname">copy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.SwigPyIterator.copy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.SwigPyIterator.decr">
<code class="descname">decr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.SwigPyIterator.decr" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.SwigPyIterator.distance">
<code class="descname">distance</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.SwigPyIterator.distance" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.SwigPyIterator.equal">
<code class="descname">equal</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.SwigPyIterator.equal" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.SwigPyIterator.incr">
<code class="descname">incr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.SwigPyIterator.incr" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.SwigPyIterator.next">
<code class="descname">next</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.SwigPyIterator.next" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.SwigPyIterator.previous">
<code class="descname">previous</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.SwigPyIterator.previous" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.SwigPyIterator.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.SwigPyIterator.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.SwigPyIterator.value">
<code class="descname">value</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.SwigPyIterator.value" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.XSControl_ConnectedShapes">
<em class="property">class </em><code class="descname">XSControl_ConnectedShapes</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_ConnectedShapes" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.IFSelect.html#OCC.IFSelect.IFSelect_SelectExplore" title="OCC.IFSelect.IFSelect_SelectExplore"><code class="xref py py-class docutils literal"><span class="pre">OCC.IFSelect.IFSelect_SelectExplore</span></code></a></p>
<ul class="simple">
<li>Creates a Selection ConnectedShapes. It remains to be set a TransferReader</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>Creates a Selection ConnectedShapes, which will work with the current TransferProcess brought by the TransferReader</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>TR</strong> (<em>Handle_XSControl_TransferReader &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<dl class="staticmethod">
<dt id="OCC.XSControl.XSControl_ConnectedShapes.AdjacentEntities">
<em class="property">static </em><code class="descname">AdjacentEntities</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_ConnectedShapes.AdjacentEntities" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>This functions considers a shape from a transfer and performs the search function explained above</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>ashape</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
<li><strong>TP</strong> (<em>Handle_Transfer_TransientProcess &amp;</em>) – </li>
<li><strong>type</strong> (<em>TopAbs_ShapeEnum</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfTransient" title="OCC.TColStd.Handle_TColStd_HSequenceOfTransient">Handle_TColStd_HSequenceOfTransient</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_ConnectedShapes.GetHandle">
<code class="descname">GetHandle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_ConnectedShapes.GetHandle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_ConnectedShapes.SetReader">
<code class="descname">SetReader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_ConnectedShapes.SetReader" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a TransferReader to sort entities : it brings the TransferProcess which may change, while the TransferReader does not</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>TR</strong> (<em>Handle_XSControl_TransferReader &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.XSControl_ConnectedShapes.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.XSControl_ConnectedShapes.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.XSControl_ConnectedShapes_AdjacentEntities">
<code class="descname">XSControl_ConnectedShapes_AdjacentEntities</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_ConnectedShapes_AdjacentEntities" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>This functions considers a shape from a transfer and performs the search function explained above</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>ashape</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
<li><strong>TP</strong> (<em>Handle_Transfer_TransientProcess &amp;</em>) – </li>
<li><strong>type</strong> (<em>TopAbs_ShapeEnum</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfTransient" title="OCC.TColStd.Handle_TColStd_HSequenceOfTransient">Handle_TColStd_HSequenceOfTransient</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.XSControl_Controller">
<em class="property">class </em><code class="descname">XSControl_Controller</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.MMgt.html#OCC.MMgt.MMgt_TShared" title="OCC.MMgt.MMgt_TShared"><code class="xref py py-class docutils literal"><span class="pre">OCC.MMgt.MMgt_TShared</span></code></a></p>
<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.ActorRead">
<code class="descname">ActorRead</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.ActorRead" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Actor for Read attached to the pair (norm,appli) It can be adapted for data of the input Model, as required Can be read from field then adapted with Model as required</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> (<em>Handle_Interface_InterfaceModel &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Handle_Transfer_ActorOfTransientProcess</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.ActorWrite">
<code class="descname">ActorWrite</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.ActorWrite" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Actor for Write attached to the pair (norm,appli) Read from field. Can be redefined</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Handle_Transfer_ActorOfFinderProcess</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.AdaptorSession">
<code class="descname">AdaptorSession</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.AdaptorSession" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Dico.html#OCC.Dico.Handle_Dico_DictionaryOfTransient" title="OCC.Dico.Handle_Dico_DictionaryOfTransient">Handle_Dico_DictionaryOfTransient</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.AddControlItem">
<code class="descname">AddControlItem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.AddControlItem" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Adds an item in the control list A control item of a controller is accessed by its name which is specific of a kind of item (i.e. a kind of functionnality) Adds or replaces if &lt;name&gt; is already recorded</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>item</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>name</strong> (<em>char *</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.AddSessionItem">
<code class="descname">AddSessionItem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.AddSessionItem" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Records a Session Item, to be added for customisation of the Work Session. It must have a specific name. &lt;setapplied&gt; is used if &lt;item&gt; is a GeneralModifier, to decide to which hook list it will be applied, if not empty (else, not applied to any hook list) ACTUAL : only one hook list is managed : ‘send’ Remark : this method is to be called at Create time, the recorded items will be used by Customise Warning : if &lt;name&gt; conflicts, the last recorded item is kept</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>item</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>name</strong> (<em>char *</em>) – </li>
<li><strong>setapplied</strong> (<em>char *</em>) – default value is</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.ApplyProfile">
<code class="descname">ApplyProfile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.ApplyProfile" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Applies a Configuration of the Profile to the WorkSession I.E. calls SetProfile then fills WorkSession with definitions</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>WS</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </li>
<li><strong>confname</strong> (<em>char *</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.ApplyingProfile">
<code class="descname">ApplyingProfile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.ApplyingProfile" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Called by ApplyProfile, can be redefined for specific sub-class of Controller The default does nothing</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>WS</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </li>
<li><strong>confname</strong> (<em>char *</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.AutoRecord">
<code class="descname">AutoRecord</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.AutoRecord" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Records &lt;self&gt; is a general dictionary under Short and Long Names (see method Name)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.ClusterContext">
<code class="descname">ClusterContext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.ClusterContext" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Prepares and returns a context to resolve a cluster All data to be used are detained by the WorkSession The definition of this context is free and proper to each case remark that it is aimed to be used in ResolveCluster //! The context must be prepared, but resolution must not have began //! If no cluster has to be resolved, should return a null handle This is the default case, which can be redefined</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>WS</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Standard.html#OCC.Standard.Handle_Standard_Transient" title="OCC.Standard.Handle_Standard_Transient">Handle_Standard_Transient</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.ControlItem">
<code class="descname">ControlItem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.ControlItem" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns a control item from its name, Null if &lt;name&gt; unknown To be used then, it just remains to be down-casted</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Standard.html#OCC.Standard.Handle_Standard_Transient" title="OCC.Standard.Handle_Standard_Transient">Handle_Standard_Transient</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.Customise">
<code class="descname">Customise</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.Customise" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Customises a WorkSession, by adding to it the recorded items (by AddSessionItem), then by calling a specific method Customising, set by default to do nothing</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>WS</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">void</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.Customising">
<code class="descname">Customising</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.Customising" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Specific customisation method, which can be redefined Default does nothing</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>WS</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.DefineProfile">
<code class="descname">DefineProfile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.DefineProfile" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Considers the current state of the Controller as defining a configuration, newly created or already existing</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>confname</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.GetHandle">
<code class="descname">GetHandle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.GetHandle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.IsApplied">
<code class="descname">IsApplied</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.IsApplied" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns True if &lt;item&gt; is recorded as &lt;setapplied = True&gt;</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>item</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.IsModeWrite">
<code class="descname">IsModeWrite</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.IsModeWrite" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Tells if a value of &lt;modetrans&gt; is a good value(within bounds) Actually only for shapes</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>modetrans</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>shape</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="staticmethod">
<dt id="OCC.XSControl.XSControl_Controller.ListRecorded">
<em class="property">static </em><code class="descname">ListRecorded</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.ListRecorded" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the list of names of recorded norms, according to mode = 0 (D) : all the recorded names &lt; 0 : for each distinct norm, its resource (short) name &gt; 0 : for each distinct norm, its complete (long) name</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfHAsciiString" title="OCC.TColStd.Handle_TColStd_HSequenceOfHAsciiString">Handle_TColStd_HSequenceOfHAsciiString</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.ModeWriteBounds">
<code class="descname">ModeWriteBounds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.ModeWriteBounds" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns recorded min and max values for modetrans (write) Actually only for shapes Returns True if bounds are set, False else (then, free value)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>modemin</strong> (<em>int &amp;</em>) – </li>
<li><strong>modemax</strong> (<em>int &amp;</em>) – </li>
<li><strong>shape</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.ModeWriteHelp">
<code class="descname">ModeWriteHelp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.ModeWriteHelp" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the help line recorded for a value of modetrans empty if help not defined or not within bounds or if values are free</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>modetrans</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>shape</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">char *</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.Name">
<code class="descname">Name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.Name" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns a name, as given when initializing : rsc = False (D) : True Name attached to the Norm (long name) rsc = True : Name of the ressource set (i.e. short name)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rsc</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_False</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">char *</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.NewModel">
<code class="descname">NewModel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.NewModel" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Creates a new empty Model ready to receive data of the Norm Used to write data from Imagine to an interface file</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Interface.html#OCC.Interface.Handle_Interface_InterfaceModel" title="OCC.Interface.Handle_Interface_InterfaceModel">Handle_Interface_InterfaceModel</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.Profile">
<code class="descname">Profile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.Profile" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Profile It starts with a first configuration Base (empty) and the following options : protocol for the Protocol sign-type for the SignType (Default Signature for Type) access for the WorkLibrary tr-read for ActorRead (import processor) tr-write for ActorWrite (export processor)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Handle_IFSelect_Profile</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.Protocol">
<code class="descname">Protocol</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.Protocol" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Protocol attached to the Norm (from field)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Interface.html#OCC.Interface.Handle_Interface_Protocol" title="OCC.Interface.Handle_Interface_Protocol">Handle_Interface_Protocol</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.RecognizeWriteShape">
<code class="descname">RecognizeWriteShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.RecognizeWriteShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Tells if a shape is valid for a transfer to a model Asks the ActorWrite (through a ShapeMapper)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>shape</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
<li><strong>modetrans</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.RecognizeWriteTransient">
<code class="descname">RecognizeWriteTransient</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.RecognizeWriteTransient" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Tells if &lt;obj&gt; (an application object) is a valid candidate for a transfer to a Model. By default, asks the ActorWrite if known (through a TransientMapper). Can be redefined</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>obj</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>modetrans</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.Record">
<code class="descname">Record</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.Record" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Records &lt;self&gt; in a general dictionary under a name Error if &lt;name&gt; already used for another one</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="staticmethod">
<dt id="OCC.XSControl.XSControl_Controller.Recorded">
<em class="property">static </em><code class="descname">Recorded</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span> &#x2192; OCC.XSControl.Handle_XSControl_Controller<a class="headerlink" href="#OCC.XSControl.XSControl_Controller.Recorded" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Controller attached to a given name Returns a Null Handle if &lt;name&gt; is unknown</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#OCC.XSControl.Handle_XSControl_Controller" title="OCC.XSControl.Handle_XSControl_Controller">Handle_XSControl_Controller</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.ResolveCluster">
<code class="descname">ResolveCluster</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.ResolveCluster" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Performs the resolution itself, from the starting data and the cluster context //! Can fill a CheckList as necessary (especially when one or more references remain unresolved) //! Default does nothing and returns an empty CheckList</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>WS</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </li>
<li><strong>context</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.Interface.html#OCC.Interface.Interface_CheckIterator" title="OCC.Interface.Interface_CheckIterator">Interface_CheckIterator</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.SessionItem">
<code class="descname">SessionItem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.SessionItem" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns an item given its name to record in a Session If &lt;name&gt; is unknown, returns a Null Handle</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Standard.html#OCC.Standard.Handle_Standard_Transient" title="OCC.Standard.Handle_Standard_Transient">Handle_Standard_Transient</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.SetModeWrite">
<code class="descname">SetModeWrite</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.SetModeWrite" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets mininum and maximum values for modetrans (write) Erases formerly recorded bounds and values Actually only for shape Then, for each value a little help can be attached</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>modemin</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>modemax</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>shape</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.SetModeWriteHelp">
<code class="descname">SetModeWriteHelp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.SetModeWriteHelp" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Attaches a short line of help to a value of modetrans (write)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>modetrans</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>help</strong> (<em>char *</em>) – </li>
<li><strong>shape</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.SetNames">
<code class="descname">SetNames</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.SetNames" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Changes names if a name is empty, the formerly set one remains Remark : Does not call Record or AutoRecord</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>longname</strong> (<em>char *</em>) – </li>
<li><strong>shortname</strong> (<em>char *</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.SetProfile">
<code class="descname">SetProfile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.SetProfile" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets the Controller in a given Configuration of its Profile Calls SettingProfile (which can be redefined) //! Returns True if done, False if &lt;confname&gt; unknown</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>confname</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.SettingProfile">
<code class="descname">SettingProfile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.SettingProfile" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>This method is called by SetProfile, it can be redefined for specific sub-class of Controller The default does nothing</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>confname</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.SignType">
<code class="descname">SignType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.SignType" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the SignType attached to the norm (from field)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.IFSelect.html#OCC.IFSelect.Handle_IFSelect_Signature" title="OCC.IFSelect.Handle_IFSelect_Signature">Handle_IFSelect_Signature</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.TraceStatic">
<code class="descname">TraceStatic</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.TraceStatic" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Records the name of a Static to be traced for a given use</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> (<em>char *</em>) – </li>
<li><strong>use</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.TransferWriteShape">
<code class="descname">TransferWriteShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.TransferWriteShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Takes one Shape and transfers it to an InterfaceModel (already created, e.g. by NewModel) Default uses ActorWrite; can be redefined as necessary Returned value is a status, as follows : Done OK , Void : No Result , Fail : Fail (e.g. exception) Error : bad conditions , bad model or null model Resolution of file clusters According to each norm, there can (or not) be files of which definition is not complete but refers to other files : this defines a file cluster. It can then be resolved by two calls : - ClusterContext prepares the resolution, specific of each case - ResolveCluster performs the resolution, its result consists in having all data gathered in one final model</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>shape</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
<li><strong>FP</strong> (<em>Handle_Transfer_FinderProcess &amp;</em>) – </li>
<li><strong>model</strong> (<em>Handle_Interface_InterfaceModel &amp;</em>) – </li>
<li><strong>modetrans</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">IFSelect_ReturnStatus</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.TransferWriteTransient">
<code class="descname">TransferWriteTransient</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.TransferWriteTransient" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Takes one Transient Object and transfers it to an InterfaceModel (already created, e.g. by NewModel) (result is recorded in the model by AddWithRefs) FP records produced results and checks //! Default uses ActorWrite; can be redefined as necessary Returned value is a status, as follows : 0 OK , 1 No Result , 2 Fail (e.g. exception raised) -1 bad conditions , -2 bad model or null model For type of object not recognized : should return 1</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>obj</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>FP</strong> (<em>Handle_Transfer_FinderProcess &amp;</em>) – </li>
<li><strong>model</strong> (<em>Handle_Interface_InterfaceModel &amp;</em>) – </li>
<li><strong>modetrans</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">IFSelect_ReturnStatus</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.UpdateStatics">
<code class="descname">UpdateStatics</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.UpdateStatics" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Updates static values &lt;mode&gt; precises the kind of updating : (see Items from Static) -1 : a precise static item : criter = its name 0 : all items of a family : criter = the family name 1 : all items which match regexp name : criter = regexp name By default (criter empty) should consider all relevant statics If &lt;name&gt; is defined, can consider only this static item The provided default method does nothing, to be redefined</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>criter</strong> (<em>char *</em>) – default value is</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Controller.WorkLibrary">
<code class="descname">WorkLibrary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.WorkLibrary" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the WorkLibrary attached to the Norm. Remark that it has to be in phase with the Protocol (read from field)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.IFSelect.html#OCC.IFSelect.Handle_IFSelect_WorkLibrary" title="OCC.IFSelect.Handle_IFSelect_WorkLibrary">Handle_IFSelect_WorkLibrary</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.XSControl_Controller.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.XSControl_Controller.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.XSControl_Controller_ListRecorded">
<code class="descname">XSControl_Controller_ListRecorded</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Controller_ListRecorded" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the list of names of recorded norms, according to mode = 0 (D) : all the recorded names &lt; 0 : for each distinct norm, its resource (short) name &gt; 0 : for each distinct norm, its complete (long) name</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfHAsciiString" title="OCC.TColStd.Handle_TColStd_HSequenceOfHAsciiString">Handle_TColStd_HSequenceOfHAsciiString</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.XSControl_Controller_Recorded">
<code class="descname">XSControl_Controller_Recorded</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span> &#x2192; OCC.XSControl.Handle_XSControl_Controller<a class="headerlink" href="#OCC.XSControl.XSControl_Controller_Recorded" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Controller attached to a given name Returns a Null Handle if &lt;name&gt; is unknown</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#OCC.XSControl.Handle_XSControl_Controller" title="OCC.XSControl.Handle_XSControl_Controller">Handle_XSControl_Controller</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.XSControl_FuncShape">
<em class="property">class </em><code class="descname">XSControl_FuncShape</code><a class="headerlink" href="#OCC.XSControl.XSControl_FuncShape" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<dl class="staticmethod">
<dt id="OCC.XSControl.XSControl_FuncShape.FileAndVar">
<em class="property">static </em><code class="descname">FileAndVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_FuncShape.FileAndVar" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Analyses given file name and variable name, with a default name for variables. Returns resulting file name and variable name plus status ‘file to read’(True) or ‘already read’(False) In the latter case, empty resfile means no file available //! If &lt;file&gt; is null or empty or equates ‘.’, considers Session and returned status is False Else, returns resfile = file and status is True If &lt;var&gt; is neither null nor empty, resvar = var Else, the root part of &lt;resfile&gt; is considered, if defined Else, &lt;def&gt; is taken</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>session</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </li>
<li><strong>file</strong> (<em>char *</em>) – </li>
<li><strong>var</strong> (<em>char *</em>) – </li>
<li><strong>def</strong> (<em>char *</em>) – </li>
<li><strong>resfile</strong> (<em>TCollection_AsciiString &amp;</em>) – </li>
<li><strong>resvar</strong> (<em>TCollection_AsciiString &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="staticmethod">
<dt id="OCC.XSControl.XSControl_FuncShape.Init">
<em class="property">static </em><code class="descname">Init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_FuncShape.Init" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Defines and loads all functions which work on shapes for XSControl (as ActFunc)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">void</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="staticmethod">
<dt id="OCC.XSControl.XSControl_FuncShape.MoreShapes">
<em class="property">static </em><code class="descname">MoreShapes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_FuncShape.MoreShapes" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Analyses a name as designating Shapes from a Vars or from XSTEP transfer (last Transfer on Reading). &lt;name&gt; can be : ‘*’ : all the root shapes produced by last Transfer (Read) i.e. considers roots of the TransientProcess a name : a name of a variable DRAW //! Returns the count of designated Shapes. Their list is put in &lt;list&gt;. If &lt;list&gt; is null, it is firstly created. Then it is completed (Append without Clear) by the Shapes found Returns 0 if no Shape could be found</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>session</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </li>
<li><strong>list</strong> (<em>Handle_TopTools_HSequenceOfShape &amp;</em>) – </li>
<li><strong>name</strong> (<em>char *</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.XSControl_FuncShape.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.XSControl_FuncShape.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.XSControl_FuncShape_FileAndVar">
<code class="descname">XSControl_FuncShape_FileAndVar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_FuncShape_FileAndVar" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Analyses given file name and variable name, with a default name for variables. Returns resulting file name and variable name plus status ‘file to read’(True) or ‘already read’(False) In the latter case, empty resfile means no file available //! If &lt;file&gt; is null or empty or equates ‘.’, considers Session and returned status is False Else, returns resfile = file and status is True If &lt;var&gt; is neither null nor empty, resvar = var Else, the root part of &lt;resfile&gt; is considered, if defined Else, &lt;def&gt; is taken</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>session</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </li>
<li><strong>file</strong> (<em>char *</em>) – </li>
<li><strong>var</strong> (<em>char *</em>) – </li>
<li><strong>def</strong> (<em>char *</em>) – </li>
<li><strong>resfile</strong> (<em>TCollection_AsciiString &amp;</em>) – </li>
<li><strong>resvar</strong> (<em>TCollection_AsciiString &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.XSControl_FuncShape_Init">
<code class="descname">XSControl_FuncShape_Init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_FuncShape_Init" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Defines and loads all functions which work on shapes for XSControl (as ActFunc)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">void</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.XSControl_FuncShape_MoreShapes">
<code class="descname">XSControl_FuncShape_MoreShapes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_FuncShape_MoreShapes" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Analyses a name as designating Shapes from a Vars or from XSTEP transfer (last Transfer on Reading). &lt;name&gt; can be : ‘*’ : all the root shapes produced by last Transfer (Read) i.e. considers roots of the TransientProcess a name : a name of a variable DRAW //! Returns the count of designated Shapes. Their list is put in &lt;list&gt;. If &lt;list&gt; is null, it is firstly created. Then it is completed (Append without Clear) by the Shapes found Returns 0 if no Shape could be found</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>session</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </li>
<li><strong>list</strong> (<em>Handle_TopTools_HSequenceOfShape &amp;</em>) – </li>
<li><strong>name</strong> (<em>char *</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.XSControl_Functions">
<em class="property">class </em><code class="descname">XSControl_Functions</code><a class="headerlink" href="#OCC.XSControl.XSControl_Functions" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<dl class="staticmethod">
<dt id="OCC.XSControl.XSControl_Functions.Init">
<em class="property">static </em><code class="descname">Init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Functions.Init" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Defines and loads all functions for XSControl (as ActFunc)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">void</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.XSControl_Functions.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.XSControl_Functions.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.XSControl_Functions_Init">
<code class="descname">XSControl_Functions_Init</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Functions_Init" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Defines and loads all functions for XSControl (as ActFunc)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">void</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.XSControl_Reader">
<em class="property">class </em><code class="descname">XSControl_Reader</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<ul class="simple">
<li>Creates a Reader from scratch (creates an empty WorkSession) A WorkSession or a Controller must be provided before running</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>Creates a Reader from scratch, with a norm name which identifies a Controller</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>norm</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>Creates a Reader from an already existing Session, with a Controller already set Virtual destructor</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>WS</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </li>
<li><strong>scratch</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.ClearShapes">
<code class="descname">ClearShapes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.ClearShapes" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Clears the list of shapes that may have accumulated in calls to TransferOne or TransferRoot.C</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.GetStatsTransfer">
<code class="descname">GetStatsTransfer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.GetStatsTransfer" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Gives statistics about Transfer</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>list</strong> (<em>Handle_TColStd_HSequenceOfTransient &amp;</em>) – </li>
<li><strong>nbMapped</strong> (<em>int &amp;</em>) – </li>
<li><strong>nbWithResult</strong> (<em>int &amp;</em>) – </li>
<li><strong>nbWithFail</strong> (<em>int &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.GiveList">
<code class="descname">GiveList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.GiveList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns a list of entities from the IGES or STEP file according to the following rules: - if first and second are empty strings, the whole file is selected. - if first is an entity number or label, the entity referred to is selected. - if first is a list of entity numbers/labels separated by commas, the entities referred to are selected, - if first is the name of a selection in the worksession and second is not defined, the list contains the standard output for that selection. - if first is the name of a selection and second is defined, the criterion defined by second is applied to the result of the first selection. A selection is an operator which computes a list of entities from a list given in input according to its type. If no list is specified, the selection computes its list of entities from the whole model. A selection can be: - A predefined selection (xst-transferrable-mode) - A filter based on a signature A Signature is an operator which returns a string from an entity according to its type. For example: - ‘xst-type’ (CDL) - ‘iges-level’ - ‘step-type’. For example, if you wanted to select only the advanced_faces in a STEP file you would use the following code: Example Reader.GiveList(‘xst-transferrable-roots’,’step-type(ADVANCED_FACE)’); Warning If the value given to second is incorrect, it will simply be ignored.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>first</strong> (<em>char *</em>) – default value is</li>
<li><strong>second</strong> (<em>char *</em>) – default value is</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfTransient" title="OCC.TColStd.Handle_TColStd_HSequenceOfTransient">Handle_TColStd_HSequenceOfTransient</a></p>
</td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>Computes a List of entities from the model as follows &lt;first&gt; beeing a Selection, &lt;ent&gt; beeing an entity or a list of entities (as a HSequenceOfTransient) : the standard result of this selection applied to this list if &lt;first&gt; is erroneous, a null handle is returned</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>first</strong> (<em>char *</em>) – </li>
<li><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfTransient" title="OCC.TColStd.Handle_TColStd_HSequenceOfTransient">Handle_TColStd_HSequenceOfTransient</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.Model">
<code class="descname">Model</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.Model" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the model. It can then be consulted (header, product)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Interface.html#OCC.Interface.Handle_Interface_InterfaceModel" title="OCC.Interface.Handle_Interface_InterfaceModel">Handle_Interface_InterfaceModel</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.NbRootsForTransfer">
<code class="descname">NbRootsForTransfer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.NbRootsForTransfer" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Determines the list of root entities which are candidate for a transfer to a Shape, and returns the number of entities in the list</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.NbShapes">
<code class="descname">NbShapes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.NbShapes" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the number of shapes produced by translation.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.OneShape">
<code class="descname">OneShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.OneShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns all of the results in a single shape which is: - a null shape if there are no results, - a shape if there is one result, - a compound containing the resulting shapes if there are more than one.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TopoDS.html#OCC.TopoDS.TopoDS_Shape" title="OCC.TopoDS.TopoDS_Shape">TopoDS_Shape</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.PrintCheckLoad">
<code class="descname">PrintCheckLoad</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.PrintCheckLoad" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Prints the check list attached to loaded data, on the Standard Trace File (starts at cout) All messages or fails only, according to &lt;failsonly&gt; mode = 0 : per entity, prints messages mode = 1 : per message, just gives count of entities per check mode = 2 : also gives entity numbers</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>failsonly</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – </li>
<li><strong>mode</strong> (<em>IFSelect_PrintCount</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.PrintCheckTransfer">
<code class="descname">PrintCheckTransfer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.PrintCheckTransfer" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Displays check results for the last translation of IGES or STEP entities to Open CASCADE entities. Only fail messages are displayed if failsonly is true. All messages are displayed if failsonly is false. mode determines the contents and the order of the messages according to the terms of the IFSelect_PrintCount enumeration.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>failsonly</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – </li>
<li><strong>mode</strong> (<em>IFSelect_PrintCount</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.PrintStatsTransfer">
<code class="descname">PrintStatsTransfer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.PrintStatsTransfer" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Displays the statistics for the last translation. what defines the kind of statistics that are displayed as follows: - 0 gives general statistics (number of translated roots, number of warnings, number of fail messages), - 1 gives root results, - 2 gives statistics for all checked entities, - 3 gives the list of translated entities, - 4 gives warning and fail messages, - 5 gives fail messages only. The use of mode depends on the value of what. If what is 0, mode is ignored. If what is 1, 2 or 3, mode defines the following: - 0 lists the numbers of IGES or STEP entities in the respective model - 1 gives the number, identifier, type and result type for each IGES or STEP entity and/or its status (fail, warning, etc.) - 2 gives maximum information for each IGES or STEP entity (i.e. checks) - 3 gives the number of entities per type of IGES or STEP entity - 4 gives the number of IGES or STEP entities per result type and/or status - 5 gives the number of pairs (IGES or STEP or result type and status) - 6 gives the number of pairs (IGES or STEP or result type and status) AND the list of entity numbers in the IGES or STEP model. If what is 4 or 5, mode defines the warning and fail messages as follows: - if mode is 0 all warnings and checks per entity are returned - if mode is 2 the list of entities per warning is returned. If mode is not set, only the list of all entities per warning is given.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>what</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.ReadFile">
<code class="descname">ReadFile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.ReadFile" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Loads a file and returns the read status Zero for a Model which compies with the Controller</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">IFSelect_ReturnStatus</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.RootForTransfer">
<code class="descname">RootForTransfer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.RootForTransfer" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns an IGES or STEP root entity for translation. The entity is identified by its rank in a list.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>num</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 1</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Standard.html#OCC.Standard.Handle_Standard_Transient" title="OCC.Standard.Handle_Standard_Transient">Handle_Standard_Transient</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.SetNorm">
<code class="descname">SetNorm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.SetNorm" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a specific norm to &lt;self&gt; Returns True if done, False if &lt;norm&gt; is not available</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>norm</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.SetWS">
<code class="descname">SetWS</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.SetWS" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a specific session to &lt;self&gt;</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>WS</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </li>
<li><strong>scratch</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.Shape">
<code class="descname">Shape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.Shape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the shape resulting from a translation and identified by the rank num. num equals 1 by default. In other words, the first shape resulting from the translation is returned.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>num</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 1</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TopoDS.html#OCC.TopoDS.TopoDS_Shape" title="OCC.TopoDS.TopoDS_Shape">TopoDS_Shape</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.TransferEntity">
<code class="descname">TransferEntity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.TransferEntity" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Translates an IGES or STEP entity in the model. true is returned if a shape is produced; otherwise, false is returned.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>start</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.TransferList">
<code class="descname">TransferList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.TransferList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Translates a list of entities. Returns the number of IGES or STEP entities that were successfully translated. The list can be produced with GiveList. Warning - This function does not clear the existing output shapes.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>list</strong> (<em>Handle_TColStd_HSequenceOfTransient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.TransferOne">
<code class="descname">TransferOne</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.TransferOne" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Translates an IGES or STEP entity identified by the rank num in the model. false is returned if no shape is produced.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>num</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.TransferOneRoot">
<code class="descname">TransferOneRoot</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.TransferOneRoot" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Translates a root identified by the rank num in the model. false is returned if no shape is produced.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>num</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 1</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.TransferRoots">
<code class="descname">TransferRoots</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.TransferRoots" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Translates all translatable roots and returns the number of successful translations. Warning - This function clears existing output shapes first.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Reader.WS">
<code class="descname">WS</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.WS" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the session used in &lt;self&gt;</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#OCC.XSControl.Handle_XSControl_WorkSession" title="OCC.XSControl.Handle_XSControl_WorkSession">Handle_XSControl_WorkSession</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.XSControl_Reader.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.XSControl_Reader.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.XSControl_SelectForTransfer">
<em class="property">class </em><code class="descname">XSControl_SelectForTransfer</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_SelectForTransfer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.IFSelect.html#OCC.IFSelect.IFSelect_SelectExtract" title="OCC.IFSelect.IFSelect_SelectExtract"><code class="xref py py-class docutils literal"><span class="pre">OCC.IFSelect.IFSelect_SelectExtract</span></code></a></p>
<ul class="simple">
<li>Creates a SelectForTransfer, non initialised it sorts nothing, unless an Actor has been defined</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>Creates a SelectForTransfer, which will work with the currently defined Actor brought by the TransferReader</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>TR</strong> (<em>Handle_XSControl_TransferReader &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="OCC.XSControl.XSControl_SelectForTransfer.Actor">
<code class="descname">Actor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_SelectForTransfer.Actor" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Actor used as precised one. Returns a Null Handle for a creation from a TransferReader without any further setting</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Handle_Transfer_ActorOfTransientProcess</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_SelectForTransfer.GetHandle">
<code class="descname">GetHandle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_SelectForTransfer.GetHandle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_SelectForTransfer.Reader">
<code class="descname">Reader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_SelectForTransfer.Reader" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Reader (if created with a Reader) Returns a Null Handle if not created with a Reader</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#OCC.XSControl.Handle_XSControl_TransferReader" title="OCC.XSControl.Handle_XSControl_TransferReader">Handle_XSControl_TransferReader</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_SelectForTransfer.SetActor">
<code class="descname">SetActor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_SelectForTransfer.SetActor" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a precise actor to sort entities This definition oversedes the creation with a TransferReader</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>act</strong> (<em>Handle_Transfer_ActorOfTransientProcess &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_SelectForTransfer.SetReader">
<code class="descname">SetReader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_SelectForTransfer.SetReader" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a TransferReader to sort entities : it brings the Actor, which may change, while the TransferReader does not</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>TR</strong> (<em>Handle_XSControl_TransferReader &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.XSControl_SelectForTransfer.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.XSControl_SelectForTransfer.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.XSControl_SignTransferStatus">
<em class="property">class </em><code class="descname">XSControl_SignTransferStatus</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_SignTransferStatus" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.IFSelect.html#OCC.IFSelect.IFSelect_Signature" title="OCC.IFSelect.IFSelect_Signature"><code class="xref py py-class docutils literal"><span class="pre">OCC.IFSelect.IFSelect_Signature</span></code></a></p>
<ul class="simple">
<li>Creates a SignTransferStatus, not initialised it gives nothing (empty string)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>Creates a SignTransferStatus, which will work on the current TransientProcess brought by the TransferReader (its MapReader)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>TR</strong> (<em>Handle_XSControl_TransferReader &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="OCC.XSControl.XSControl_SignTransferStatus.GetHandle">
<code class="descname">GetHandle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_SignTransferStatus.GetHandle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_SignTransferStatus.Map">
<code class="descname">Map</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_SignTransferStatus.Map" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the TransientProcess used as precised one Returns a Null Handle for a creation from a TransferReader without any further setting</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Handle_Transfer_TransientProcess</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_SignTransferStatus.Reader">
<code class="descname">Reader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_SignTransferStatus.Reader" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Reader (if created with a Reader) Returns a Null Handle if not created with a Reader</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#OCC.XSControl.Handle_XSControl_TransferReader" title="OCC.XSControl.Handle_XSControl_TransferReader">Handle_XSControl_TransferReader</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_SignTransferStatus.SetMap">
<code class="descname">SetMap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_SignTransferStatus.SetMap" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a precise map to sign entities This definition oversedes the creation with a TransferReader</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>TP</strong> (<em>Handle_Transfer_TransientProcess &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_SignTransferStatus.SetReader">
<code class="descname">SetReader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_SignTransferStatus.SetReader" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a TransferReader to work</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>TR</strong> (<em>Handle_XSControl_TransferReader &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.XSControl_SignTransferStatus.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.XSControl_SignTransferStatus.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.XSControl_TransferReader">
<em class="property">class </em><code class="descname">XSControl_TransferReader</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.MMgt.html#OCC.MMgt.MMgt_TShared" title="OCC.MMgt.MMgt_TShared"><code class="xref py py-class docutils literal"><span class="pre">OCC.MMgt.MMgt_TShared</span></code></a></p>
<ul class="simple">
<li>Creates a TransferReader, empty</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.Actor">
<code class="descname">Actor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.Actor" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Actor, determined by the Controller, or if this one is unknown, directly set. Once it has been defined, it can then be edited.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Handle_Transfer_ActorOfTransientProcess</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.BeginTransfer">
<code class="descname">BeginTransfer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.BeginTransfer" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Defines a new TransferProcess for reading transfer Returns True if done, False if data are not properly defined (the Model, the Actor for Read)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.CheckList">
<code class="descname">CheckList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.CheckList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the CheckList resulting from transferring &lt;ent&gt;, i.e. stored in its recorded form ResultFromModel (empty if transfer successful or not recorded …) //! If &lt;ent&gt; is the Model, returns the complete cumulated check-list, &lt;level&gt; is ignored //! If &lt;ent&gt; is an entity of the Model, &lt;level&gt; applies as follows &lt;level&gt; : -1 for &lt;ent&gt; only, LAST transfer (TransientProcess) &lt;level&gt; : 0 for &lt;ent&gt; only (D) 1 for &lt;ent&gt; and its immediate subtransfers, if any 2 for &lt;ent&gt; and subtransferts at all levels</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>level</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.Interface.html#OCC.Interface.Interface_CheckIterator" title="OCC.Interface.Interface_CheckIterator">Interface_CheckIterator</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.CheckedList">
<code class="descname">CheckedList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.CheckedList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the list of starting entities to which a given check status is attached, IN FINAL RESULTS &lt;ent&gt; can be an entity, or the model to query all entities Below, ‘entities’ are, either &lt;ent&gt; plus its sub-transferred, or all the entities of the model //! &lt;check&gt; = -2 , all entities whatever the check (see result) &lt;check&gt; = -1 , entities with no fail (warning allowed) &lt;check&gt; = 0 , entities with no check at all &lt;check&gt; = 1 , entities with warning but no fail &lt;check&gt; = 2 , entities with fail &lt;result&gt; : if True, only entities with an attached result Remark : result True and check=0 will give an empty list</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>withcheck</strong> (<em>Interface_CheckStatus</em>) – default value is Interface_CheckAny</li>
<li><strong>result</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfTransient" title="OCC.TColStd.Handle_TColStd_HSequenceOfTransient">Handle_TColStd_HSequenceOfTransient</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.Clear">
<code class="descname">Clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.Clear" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Clears data, according mode : -1 all 0 nothing done +1 final results +2 working data (model, context, transfer process)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.ClearResult">
<code class="descname">ClearResult</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.ClearResult" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Clears recorded result for an entity, according mode &lt;mode&gt; = -1 : true, complete, clearing (erasing result) &lt;mode&gt; &gt;= 0 : simple ‘stripping’, see ResultFromModel, in particular, 0 for simple internal strip, 10 for all but final result, 11 for all : just label, status and filename are kept Returns True when done, False if nothing was to clear</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.Context">
<code class="descname">Context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.Context" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns (modifiable) the whole definition of Context Rather for internal use (ex.: preparing and setting in once)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Dico.html#OCC.Dico.Handle_Dico_DictionaryOfTransient" title="OCC.Dico.Handle_Dico_DictionaryOfTransient">Handle_Dico_DictionaryOfTransient</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.EntitiesFromShapeList">
<code class="descname">EntitiesFromShapeList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.EntitiesFromShapeList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the list of entities from which some shapes were produced : it corresponds to a loop on EntityFromShapeResult, but is optimised</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>res</strong> (<em>Handle_TopTools_HSequenceOfShape &amp;</em>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfTransient" title="OCC.TColStd.Handle_TColStd_HSequenceOfTransient">Handle_TColStd_HSequenceOfTransient</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.EntityFromResult">
<code class="descname">EntityFromResult</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.EntityFromResult" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns an entity from which a given result was produced. If &lt;mode&gt; = 0 (D), searches in last root transfers If &lt;mode&gt; = 1, searches in last (root &amp; sub) transfers If &lt;mode&gt; = 2, searches in root recorded results If &lt;mode&gt; = 3, searches in all (root &amp; sub) recordeds &lt;res&gt; can be, either a transient object (result itself) or a binder. For a binder of shape, calls EntityFromShapeResult Returns a Null Handle if &lt;res&gt; not recorded</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>res</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.Standard.html#OCC.Standard.Handle_Standard_Transient" title="OCC.Standard.Handle_Standard_Transient">Handle_Standard_Transient</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.EntityFromShapeResult">
<code class="descname">EntityFromShapeResult</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.EntityFromShapeResult" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns an entity from which a given shape result was produced Returns a Null Handle if &lt;res&gt; not recorded or not a Shape</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>res</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.Standard.html#OCC.Standard.Handle_Standard_Transient" title="OCC.Standard.Handle_Standard_Transient">Handle_Standard_Transient</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.FileName">
<code class="descname">FileName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.FileName" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns actual value of file name</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">char *</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.FinalEntityLabel">
<code class="descname">FinalEntityLabel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.FinalEntityLabel" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the label attached to an entity recorded for final, or an empty string if not recorded</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">char *</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.FinalEntityNumber">
<code class="descname">FinalEntityNumber</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.FinalEntityNumber" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the number attached to the entity recorded for final, or zero if not recorded (looks in the ResultFromModel)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.FinalResult">
<code class="descname">FinalResult</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.FinalResult" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the final result recorded for an entity, as such</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Handle_Transfer_ResultFromModel</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.GetContext">
<code class="descname">GetContext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.GetContext" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Context attached to a name, if set and if it is Kind of the type, else a Null Handle Returns True if OK, False if no Context</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> (<em>char *</em>) – </li>
<li><strong>type</strong> (<em>Handle_Standard_Type &amp;</em>) – </li>
<li><strong>ctx</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.GetHandle">
<code class="descname">GetHandle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.GetHandle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.HasChecks">
<code class="descname">HasChecks</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.HasChecks" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns True if an entity (with a final result) has checks : - failsonly = False : any kind of check message - failsonly = True : fails only Returns False if &lt;ent&gt; is not recorded</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>failsonly</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.HasResult">
<code class="descname">HasResult</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.HasResult" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns True if a final result is recorded AND BRINGS AN EFFECTIVE RESULT (else, it brings only fail messages)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.IsMarked">
<code class="descname">IsMarked</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.IsMarked" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns True if an entity has been asked for transfert, hence it is marked, as : Recorded (a computation has ran, with or without an effective result), or Skipped (case ignored)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.IsRecorded">
<code class="descname">IsRecorded</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.IsRecorded" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns True if a final result is recorded for an entity Remark that it can bring no effective result if transfer has completely failed (FinalResult brings only fail messages …)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.IsSkipped">
<code class="descname">IsSkipped</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.IsSkipped" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns True if an entity is noted as skipped</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.LastCheckList">
<code class="descname">LastCheckList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.LastCheckList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the CheckList resulting from last TransferRead i.e. from TransientProcess itself, recorded from last Clear</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Interface.html#OCC.Interface.Interface_CheckIterator" title="OCC.Interface.Interface_CheckIterator">Interface_CheckIterator</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.LastTransferList">
<code class="descname">LastTransferList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.LastTransferList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the list of entities recorded as lastly transferred i.e. from TransientProcess itself, recorded from last Clear If &lt;roots&gt; is True , considers only roots of transfer If &lt;roots&gt; is False, considers all entities bound with result</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>roots</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfTransient" title="OCC.TColStd.Handle_TColStd_HSequenceOfTransient">Handle_TColStd_HSequenceOfTransient</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.Model">
<code class="descname">Model</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.Model" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the currently set InterfaceModel</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Interface.html#OCC.Interface.Handle_Interface_InterfaceModel" title="OCC.Interface.Handle_Interface_InterfaceModel">Handle_Interface_InterfaceModel</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.PrintStats">
<code class="descname">PrintStats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.PrintStats" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Prints statistics on current Trace File, according &lt;what&gt; and &lt;mode&gt;. See PrintStatsProcess for details</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>what</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="staticmethod">
<dt id="OCC.XSControl.XSControl_TransferReader.PrintStatsOnList">
<em class="property">static </em><code class="descname">PrintStatsOnList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.PrintStatsOnList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Works as PrintStatsProcess, but displays data only on the entities which are in &lt;list&gt; (filter)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>TP</strong> (<em>Handle_Transfer_TransientProcess &amp;</em>) – </li>
<li><strong>list</strong> (<em>Handle_TColStd_HSequenceOfTransient &amp;</em>) – </li>
<li><strong>what</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="staticmethod">
<dt id="OCC.XSControl.XSControl_TransferReader.PrintStatsProcess">
<em class="property">static </em><code class="descname">PrintStatsProcess</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.PrintStatsProcess" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>This routines prints statistics about a TransientProcess It can be called, by a TransferReader, or isolately Prints are done on the default trace file &lt;what&gt; defines what kind of statistics are to be printed : 0 : basic figures 1 : root results 2 : all recorded (roots, intermediate, checked entities) 3 : abnormal records 4 : check messages (warnings and fails) 5 : fail messages //! &lt;mode&gt; is used according &lt;what&gt; : &lt;what&gt; = 0 : &lt;mode&gt; is ignored &lt;what&gt; = 1,2,3 : &lt;mode&gt; as follows : 0 (D) : just lists numbers of concerned entities in the model 1 : for each entity, gives number,label, type and result type and/or status (fail/warning…) 2 : for each entity, gives maximal information (i.e. checks) 3 : counts per type of starting entity (class type) 4 : counts per result type and/or status 5 : counts per couple (starting type / result type/status) 6 : idem plus gives for each item, the list of numbers of entities in the starting model //! &lt;what&gt; = 4,5 : modes relays on an enum PrintCount : 0 (D) : ItemsByEntity (sequential list by entity) 1 : CountByItem 2 : ShortByItem (count + 5 first numbers) 3 : ListByItem (count + entity numbers) 4 : EntitiesByItem (count + entity numbers and labels)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>TP</strong> (<em>Handle_Transfer_TransientProcess &amp;</em>) – </li>
<li><strong>what</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.Recognize">
<code class="descname">Recognize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.Recognize" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Tells if an entity is recognized as a valid candidate for Transfer. Calls method Recognize from the Actor (if known)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.RecordResult">
<code class="descname">RecordResult</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.RecordResult" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Records a final result of transferring an entity This result is recorded as a ResultFromModel, taken from the TransientProcess Returns True if a result is available, False else</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.RecordedList">
<code class="descname">RecordedList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.RecordedList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the list of entities to which a final result is attached (i.e. processed by RecordResult)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfTransient" title="OCC.TColStd.Handle_TColStd_HSequenceOfTransient">Handle_TColStd_HSequenceOfTransient</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.ResultFromNumber">
<code class="descname">ResultFromNumber</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.ResultFromNumber" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the final result recorded for a NUMBER of entity (internal use). Null if out of range</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>num</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Handle_Transfer_ResultFromModel</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.SetActor">
<code class="descname">SetActor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.SetActor" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets the Actor directly : this value will be used if the Controller is not set</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>actor</strong> (<em>Handle_Transfer_ActorOfTransientProcess &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.SetContext">
<code class="descname">SetContext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.SetContext" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a Context : according to receiving appli, to be interpreted by the Actor</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> (<em>char *</em>) – </li>
<li><strong>ctx</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.SetController">
<code class="descname">SetController</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.SetController" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a Controller. It is required to generate the Actor. Elsewhere, the Actor must be provided directly</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>control</strong> (<em>Handle_XSControl_Controller &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.SetFileName">
<code class="descname">SetFileName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.SetFileName" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a new value for (loaded) file name</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.SetGraph">
<code class="descname">SetGraph</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.SetGraph" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a Graph and its InterfaceModel (calls SetModel)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>graph</strong> (<em>Handle_Interface_HGraph &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.SetModel">
<code class="descname">SetModel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.SetModel" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets an InterfaceModel. This causes former results, computed from another one, to be lost (see also Clear)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> (<em>Handle_Interface_InterfaceModel &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.SetTransientProcess">
<code class="descname">SetTransientProcess</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.SetTransientProcess" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Forces the TransientProcess Remark : it also changes the Model and the Actor, from those recorded in the new TransientProcess</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>TP</strong> (<em>Handle_Transfer_TransientProcess &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.ShapeResult">
<code class="descname">ShapeResult</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.ShapeResult" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the resulting object as a Shape Null Shape if no result or result not a shape</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TopoDS.html#OCC.TopoDS.TopoDS_Shape" title="OCC.TopoDS.TopoDS_Shape">TopoDS_Shape</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.ShapeResultList">
<code class="descname">ShapeResultList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.ShapeResultList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns a list of result Shapes If &lt;rec&gt; is True , sees RecordedList If &lt;rec&gt; is False, sees LastTransferList (last ROOT transfers) For each one, if it is a Shape, it is cumulated to the list If no Shape is found, returns an empty Sequence</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rec</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TopTools.html#OCC.TopTools.Handle_TopTools_HSequenceOfShape" title="OCC.TopTools.Handle_TopTools_HSequenceOfShape">Handle_TopTools_HSequenceOfShape</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.Skip">
<code class="descname">Skip</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.Skip" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Note that an entity has been required for transfer but no result at all is available (typically : case not implemented) It is not an error, but it gives a specific status : Skipped Returns True if done, False if &lt;ent&gt; is not in starting model</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.TransferClear">
<code class="descname">TransferClear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.TransferClear" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Clears the results attached to an entity if &lt;ents&gt; equates the starting model, clears all results</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>level</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.TransferList">
<code class="descname">TransferList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.TransferList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Commands the transfer on reading for a list of entities to data for Imagine, using the selected Actor for Read Returns count of transferred entities, ok or with fails (0/1) If &lt;rec&gt; is True (D), the results are recorded by RecordResult</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>list</strong> (<em>Handle_TColStd_HSequenceOfTransient &amp;</em>) – </li>
<li><strong>rec</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.TransferOne">
<code class="descname">TransferOne</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.TransferOne" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Commands the transfer on reading for an entity to data for Imagine, using the selected Actor for Read Returns count of transferred entities, ok or with fails (0/1) If &lt;rec&gt; is True (D), the result is recorded by RecordResult</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>rec</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.TransferRoots">
<code class="descname">TransferRoots</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.TransferRoots" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Transfers the content of the current Interface Model to data handled by Imagine, starting from its Roots (determined by the Graph &lt;G&gt;), using the selected Actor for Read Returns the count of performed root transfers (i.e. 0 if none) or -1 if no actor is defined</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>G</strong> (<em>Interface_Graph &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.TransientProcess">
<code class="descname">TransientProcess</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.TransientProcess" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the currently used TransientProcess It is computed from the model by TransferReadRoots, or by BeginTransferRead</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Handle_Transfer_TransientProcess</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferReader.TransientResult">
<code class="descname">TransientResult</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.TransientResult" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the resulting object as a Transient Null Handle if no result or result not transient</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Standard.html#OCC.Standard.Handle_Standard_Transient" title="OCC.Standard.Handle_Standard_Transient">Handle_Standard_Transient</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.XSControl_TransferReader.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.XSControl_TransferReader_PrintStatsOnList">
<code class="descname">XSControl_TransferReader_PrintStatsOnList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader_PrintStatsOnList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Works as PrintStatsProcess, but displays data only on the entities which are in &lt;list&gt; (filter)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>TP</strong> (<em>Handle_Transfer_TransientProcess &amp;</em>) – </li>
<li><strong>list</strong> (<em>Handle_TColStd_HSequenceOfTransient &amp;</em>) – </li>
<li><strong>what</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.XSControl_TransferReader_PrintStatsProcess">
<code class="descname">XSControl_TransferReader_PrintStatsProcess</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferReader_PrintStatsProcess" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>This routines prints statistics about a TransientProcess It can be called, by a TransferReader, or isolately Prints are done on the default trace file &lt;what&gt; defines what kind of statistics are to be printed : 0 : basic figures 1 : root results 2 : all recorded (roots, intermediate, checked entities) 3 : abnormal records 4 : check messages (warnings and fails) 5 : fail messages //! &lt;mode&gt; is used according &lt;what&gt; : &lt;what&gt; = 0 : &lt;mode&gt; is ignored &lt;what&gt; = 1,2,3 : &lt;mode&gt; as follows : 0 (D) : just lists numbers of concerned entities in the model 1 : for each entity, gives number,label, type and result type and/or status (fail/warning…) 2 : for each entity, gives maximal information (i.e. checks) 3 : counts per type of starting entity (class type) 4 : counts per result type and/or status 5 : counts per couple (starting type / result type/status) 6 : idem plus gives for each item, the list of numbers of entities in the starting model //! &lt;what&gt; = 4,5 : modes relays on an enum PrintCount : 0 (D) : ItemsByEntity (sequential list by entity) 1 : CountByItem 2 : ShortByItem (count + 5 first numbers) 3 : ListByItem (count + entity numbers) 4 : EntitiesByItem (count + entity numbers and labels)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>TP</strong> (<em>Handle_Transfer_TransientProcess &amp;</em>) – </li>
<li><strong>what</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.XSControl_TransferWriter">
<em class="property">class </em><code class="descname">XSControl_TransferWriter</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.MMgt.html#OCC.MMgt.MMgt_TShared" title="OCC.MMgt.MMgt_TShared"><code class="xref py py-class docutils literal"><span class="pre">OCC.MMgt.MMgt_TShared</span></code></a></p>
<ul class="simple">
<li>Creates a TransferWriter, empty, ready to run with an empty FinderProcess (but no controller, etc)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.CheckList">
<code class="descname">CheckList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.CheckList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the check-list of last transfer (write), i.e. the check-list currently recorded in the FinderProcess</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Interface.html#OCC.Interface.Interface_CheckIterator" title="OCC.Interface.Interface_CheckIterator">Interface_CheckIterator</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.Clear">
<code class="descname">Clear</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.Clear" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Clears recorded data according a mode 0 clears FinderProcess (results, checks) -1 create a new FinderProcess</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.Controller">
<code class="descname">Controller</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.Controller" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the currently used Controller</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#OCC.XSControl.Handle_XSControl_Controller" title="OCC.XSControl.Handle_XSControl_Controller">Handle_XSControl_Controller</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.FinderProcess">
<code class="descname">FinderProcess</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.FinderProcess" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the FinderProcess itself</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Handle_Transfer_FinderProcess</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.GetHandle">
<code class="descname">GetHandle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.GetHandle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.PrintStats">
<code class="descname">PrintStats</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.PrintStats" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Prints statistics on current Trace File, according what,mode See PrintStatsProcess for details</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>what</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="staticmethod">
<dt id="OCC.XSControl.XSControl_TransferWriter.PrintStatsProcess">
<em class="property">static </em><code class="descname">PrintStatsProcess</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.PrintStatsProcess" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Forecast to print statitics about a FinderProcess</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>TP</strong> (<em>Handle_Transfer_FinderProcess &amp;</em>) – </li>
<li><strong>what</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.RecognizeShape">
<code class="descname">RecognizeShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.RecognizeShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Tells if a Shape is valid for a transfer to a model Asks the Controller (RecognizeWriteShape)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>shape</strong> (<em>TopoDS_Shape &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.RecognizeTransient">
<code class="descname">RecognizeTransient</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.RecognizeTransient" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Tells if a transient object (from an application) is a valid candidate for a transfer to a model Asks the Controller (RecognizeWriteTransient) If &lt;obj&gt; is a HShape, calls RecognizeShape</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>obj</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.ResultCheckList">
<code class="descname">ResultCheckList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.ResultCheckList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the check-list of last transfer (write), but tries to bind to each check, the resulting entity in the model instead of keeping the original Mapper, whenever known</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>model</strong> (<em>Handle_Interface_InterfaceModel &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Interface.html#OCC.Interface.Interface_CheckIterator" title="OCC.Interface.Interface_CheckIterator">Interface_CheckIterator</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.SetController">
<code class="descname">SetController</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.SetController" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a new Controller, also sets a new FinderProcess</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ctl</strong> (<em>Handle_XSControl_Controller &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.SetFinderProcess">
<code class="descname">SetFinderProcess</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.SetFinderProcess" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a new FinderProcess and forgets the former one</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>FP</strong> (<em>Handle_Transfer_FinderProcess &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.SetTransferMode">
<code class="descname">SetTransferMode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.SetTransferMode" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Changes the Transfer Mode</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.TransferMode">
<code class="descname">TransferMode</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.TransferMode" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the current Transfer Mode (an Integer) It will be interpreted by the Controller to run Transfers This call form could be later replaced by more specific ones (parameters suited for each norm / transfer case)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.TransferWriteShape">
<code class="descname">TransferWriteShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.TransferWriteShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Transfers a Shape from CasCade to a model of current norm, according to the last call to SetTransferMode Works by calling the Controller Returns status : =0 if OK, &gt;0 if error during transfer, &lt;0 if transfer badly initialised</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> (<em>Handle_Interface_InterfaceModel &amp;</em>) – </li>
<li><strong>shape</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">IFSelect_ReturnStatus</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_TransferWriter.TransferWriteTransient">
<code class="descname">TransferWriteTransient</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.TransferWriteTransient" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Transfers a Transient object (from an application) to a model of current norm, according to the last call to SetTransferMode Works by calling the Controller Returns status : =0 if OK, &gt;0 if error during transfer, &lt;0 if transfer badly initialised</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>model</strong> (<em>Handle_Interface_InterfaceModel &amp;</em>) – </li>
<li><strong>obj</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">IFSelect_ReturnStatus</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.XSControl_TransferWriter.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.XSControl_TransferWriter_PrintStatsProcess">
<code class="descname">XSControl_TransferWriter_PrintStatsProcess</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_TransferWriter_PrintStatsProcess" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Forecast to print statitics about a FinderProcess</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>TP</strong> (<em>Handle_Transfer_FinderProcess &amp;</em>) – </li>
<li><strong>what</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">void</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.XSControl_Utils">
<em class="property">class </em><code class="descname">XSControl_Utils</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<ul class="simple">
<li>the only use of this, is to allow a frontal to get one distinct ‘Utils’ set per separate engine</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.AppendCStr">
<code class="descname">AppendCStr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.AppendCStr" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>seqval</strong> (<em>Handle_TColStd_HSequenceOfHAsciiString &amp;</em>) – </li>
<li><strong>strval</strong> (<em>char *</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.AppendEStr">
<code class="descname">AppendEStr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.AppendEStr" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>seqval</strong> (<em>Handle_TColStd_HSequenceOfHExtendedString &amp;</em>) – </li>
<li><strong>strval</strong> (<em>Standard_ExtString</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.AppendShape">
<code class="descname">AppendShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.AppendShape" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>seqv</strong> (<em>Handle_TopTools_HSequenceOfShape &amp;</em>) – </li>
<li><strong>shape</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.AppendTra">
<code class="descname">AppendTra</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.AppendTra" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>seqval</strong> (<em>Handle_TColStd_HSequenceOfTransient &amp;</em>) – </li>
<li><strong>traval</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.ArrToSeq">
<code class="descname">ArrToSeq</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.ArrToSeq" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>arr</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Standard.html#OCC.Standard.Handle_Standard_Transient" title="OCC.Standard.Handle_Standard_Transient">Handle_Standard_Transient</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.AsciiToExtended">
<code class="descname">AsciiToExtended</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.AsciiToExtended" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Standard_ExtString</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.BinderShape">
<code class="descname">BinderShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.BinderShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>From a Transient, returns a Shape. In fact, recognizes ShapeBinder ShapeMapper and HShape</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>tr</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TopoDS.html#OCC.TopoDS.TopoDS_Shape" title="OCC.TopoDS.TopoDS_Shape">TopoDS_Shape</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.CStrValue">
<code class="descname">CStrValue</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.CStrValue" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>list</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>num</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">char *</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.CompoundFromSeq">
<code class="descname">CompoundFromSeq</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.CompoundFromSeq" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Converts a list of Shapes to a Compound (a kind of Shape)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>seqval</strong> (<em>Handle_TopTools_HSequenceOfShape &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TopoDS.html#OCC.TopoDS.TopoDS_Shape" title="OCC.TopoDS.TopoDS_Shape">TopoDS_Shape</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.DateString">
<code class="descname">DateString</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.DateString" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>yy</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>mm</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>dd</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>hh</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>mn</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>ss</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">char *</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.DateValues">
<code class="descname">DateValues</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.DateValues" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>text</strong> (<em>char *</em>) – </li>
<li><strong>yy</strong> (<em>int &amp;</em>) – </li>
<li><strong>mm</strong> (<em>int &amp;</em>) – </li>
<li><strong>dd</strong> (<em>int &amp;</em>) – </li>
<li><strong>hh</strong> (<em>int &amp;</em>) – </li>
<li><strong>mn</strong> (<em>int &amp;</em>) – </li>
<li><strong>ss</strong> (<em>int &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.EStrValue">
<code class="descname">EStrValue</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.EStrValue" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>list</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>num</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Standard_ExtString</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.ExtendedToAscii">
<code class="descname">ExtendedToAscii</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.ExtendedToAscii" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>Standard_ExtString</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">char *</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.IsAscii">
<code class="descname">IsAscii</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.IsAscii" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>str</strong> (<em>Standard_ExtString</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.IsKind">
<code class="descname">IsKind</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.IsKind" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>item</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>what</strong> (<em>Handle_Standard_Type &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.IsNullShape">
<code class="descname">IsNullShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.IsNullShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns True if a Shape is Null</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>shape</strong> (<em>TopoDS_Shape &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.NewSeqCStr">
<code class="descname">NewSeqCStr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.NewSeqCStr" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfHAsciiString" title="OCC.TColStd.Handle_TColStd_HSequenceOfHAsciiString">Handle_TColStd_HSequenceOfHAsciiString</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.NewSeqEStr">
<code class="descname">NewSeqEStr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.NewSeqEStr" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfHExtendedString" title="OCC.TColStd.Handle_TColStd_HSequenceOfHExtendedString">Handle_TColStd_HSequenceOfHExtendedString</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.NewSeqShape">
<code class="descname">NewSeqShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.NewSeqShape" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TopTools.html#OCC.TopTools.Handle_TopTools_HSequenceOfShape" title="OCC.TopTools.Handle_TopTools_HSequenceOfShape">Handle_TopTools_HSequenceOfShape</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.NewSeqTra">
<code class="descname">NewSeqTra</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.NewSeqTra" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TColStd.html#OCC.TColStd.Handle_TColStd_HSequenceOfTransient" title="OCC.TColStd.Handle_TColStd_HSequenceOfTransient">Handle_TColStd_HSequenceOfTransient</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.NewShape">
<code class="descname">NewShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.NewShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns a new empty, undefined Shape, which can then be filled by ReadShape</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TopoDS.html#OCC.TopoDS.TopoDS_Shape" title="OCC.TopoDS.TopoDS_Shape">TopoDS_Shape</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.ReadShape">
<code class="descname">ReadShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.ReadShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Reads a Shape from the internal BRepTools form and returns it (an internal help utility) Returns True if reading has succeeded, False else</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>shape</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
<li><strong>filename</strong> (<em>char *</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.SeqIntValue">
<code class="descname">SeqIntValue</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.SeqIntValue" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>list</strong> (<em>Handle_TColStd_HSequenceOfInteger &amp;</em>) – </li>
<li><strong>num</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.SeqLength">
<code class="descname">SeqLength</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.SeqLength" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>list</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.SeqToArr">
<code class="descname">SeqToArr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.SeqToArr" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>seq</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>first</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 1</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.Standard.html#OCC.Standard.Handle_Standard_Transient" title="OCC.Standard.Handle_Standard_Transient">Handle_Standard_Transient</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.ShapeBinder">
<code class="descname">ShapeBinder</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.ShapeBinder" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Creates a Transient Object from a Shape : it is either a Binder (used by functions which require a Transient but can process a Shape, such as viewing functions) or a HShape (according to hs) Default is a HShape</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>shape</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
<li><strong>hs</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.Standard.html#OCC.Standard.Handle_Standard_Transient" title="OCC.Standard.Handle_Standard_Transient">Handle_Standard_Transient</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.ShapeType">
<code class="descname">ShapeType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.ShapeType" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the type of a Shape : true type if &lt;compound&gt; is False If &lt;compound&gt; is True and &lt;shape&gt; is a Compound, iterates on its items. If all are of the same type, returns this type. Else, returns COMPOUND. If it is empty, returns SHAPE For a Null Shape, returns SHAPE</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>shape</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
<li><strong>compound</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">TopAbs_ShapeEnum</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.ShapeValue">
<code class="descname">ShapeValue</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.ShapeValue" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>seqv</strong> (<em>Handle_TopTools_HSequenceOfShape &amp;</em>) – </li>
<li><strong>num</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.TopoDS.html#OCC.TopoDS.TopoDS_Shape" title="OCC.TopoDS.TopoDS_Shape">TopoDS_Shape</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.SortedCompound">
<code class="descname">SortedCompound</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.SortedCompound" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>From a Shape, builds a Compound as follows : explores it level by level If &lt;explore&gt; is False, only COMPOUND items. Else, all items Adds to the result, shapes which comply to &lt;type&gt; + if &lt;type&gt; is WIRE, considers free edges (and makes wires) + if &lt;type&gt; is SHELL, considers free faces (and makes shells) If &lt;compound&gt; is True, gathers items in compounds which correspond to starting COMPOUND,SOLID or SHELL containers, or items directly contained in a Compound</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>shape</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
<li><strong>type</strong> (<em>TopAbs_ShapeEnum</em>) – </li>
<li><strong>explore</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – </li>
<li><strong>compound</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.TopoDS.html#OCC.TopoDS.TopoDS_Shape" title="OCC.TopoDS.TopoDS_Shape">TopoDS_Shape</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.ToAString">
<code class="descname">ToAString</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.ToAString" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>strcon</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TCollection.html#OCC.TCollection.TCollection_AsciiString" title="OCC.TCollection.TCollection_AsciiString">TCollection_AsciiString</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.ToCString">
<code class="descname">ToCString</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.ToCString" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>strval</strong> (<em>TCollection_AsciiString &amp;</em>) – </li>
<li><strong>strval</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">char *</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">char *</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.ToEString">
<code class="descname">ToEString</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.ToEString" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>strval</strong> (<em>TCollection_ExtendedString &amp;</em>) – </li>
<li><strong>strval</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first">Standard_ExtString</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">Standard_ExtString</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.ToHString">
<code class="descname">ToHString</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.ToHString" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>strcon</strong> (<em>Standard_ExtString</em>) – </li>
<li><strong>strcon</strong> – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><a class="reference internal" href="OCC.TCollection.html#OCC.TCollection.Handle_TCollection_HAsciiString" title="OCC.TCollection.Handle_TCollection_HAsciiString">Handle_TCollection_HAsciiString</a></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.TCollection.html#OCC.TCollection.Handle_TCollection_HExtendedString" title="OCC.TCollection.Handle_TCollection_HExtendedString">Handle_TCollection_HExtendedString</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.ToXString">
<code class="descname">ToXString</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.ToXString" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>strcon</strong> (<em>Standard_ExtString</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.TCollection.html#OCC.TCollection.TCollection_ExtendedString" title="OCC.TCollection.TCollection_ExtendedString">TCollection_ExtendedString</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.TraValue">
<code class="descname">TraValue</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.TraValue" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>list</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>num</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.Standard.html#OCC.Standard.Handle_Standard_Transient" title="OCC.Standard.Handle_Standard_Transient">Handle_Standard_Transient</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.TraceLine">
<code class="descname">TraceLine</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.TraceLine" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Just prints a line into the current Trace File. This allows to better characterise the various trace outputs, as desired.</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>line</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.TraceLines">
<code class="descname">TraceLines</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.TraceLines" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Just prints a line or a set of lines into the current Trace File. &lt;lines&gt; can be a HAscii/ExtendedString (produces a print without ending line) or a HSequence or HArray1 Of .. (one new line per item)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>lines</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.TypeName">
<code class="descname">TypeName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.TypeName" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the name of the dynamic type of an object, i.e. : If it is a Type, its Name If it is a object not a type, the Name of its DynamicType If it is Null, an empty string If &lt;nopk&gt; is False (D), gives complete name If &lt;nopk&gt; is True, returns class name without package</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>item</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>nopk</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_False</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">char *</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Utils.WriteShape">
<code class="descname">WriteShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.WriteShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Writes a Shape under the internal BRepTools form (an internal help utility) Returns True if writing has succeeded, False else</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>shape</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
<li><strong>filename</strong> (<em>char *</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.XSControl_Utils.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.XSControl_Utils.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.XSControl_WorkSession">
<em class="property">class </em><code class="descname">XSControl_WorkSession</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="OCC.IFSelect.html#OCC.IFSelect.IFSelect_WorkSession" title="OCC.IFSelect.IFSelect_WorkSession"><code class="xref py py-class docutils literal"><span class="pre">OCC.IFSelect.IFSelect_WorkSession</span></code></a></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.AdaptNorm">
<code class="descname">AdaptNorm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.AdaptNorm" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>This method is called once a new norm has been successfully selected. It can be redefined, default does nothing</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">void</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.ClearBinders">
<code class="descname">ClearBinders</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.ClearBinders" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Clears binders</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.ClearContext">
<code class="descname">ClearContext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.ClearContext" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Clears the whole current Context (nullifies it)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.Context">
<code class="descname">Context</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.Context" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the current Context List, Null if not defined The Context is given to the TransientProcess for TransferRead</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Dico.html#OCC.Dico.Handle_Dico_DictionaryOfTransient" title="OCC.Dico.Handle_Dico_DictionaryOfTransient">Handle_Dico_DictionaryOfTransient</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.Destroy">
<code class="descname">Destroy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.Destroy" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.GetHandle">
<code class="descname">GetHandle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.GetHandle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.InitTransferReader">
<code class="descname">InitTransferReader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.InitTransferReader" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a Transfer Reader, by internal ways, according mode : 0 recreates it clear, 1 clears it (does not recreate) 2 aligns Roots of TransientProcess from final Results 3 aligns final Results from Roots of TransientProcess 4 begins a new transfer (by BeginTransfer) 5 recreates TransferReader then begins a new transfer</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.MapReader">
<code class="descname">MapReader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.MapReader" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the TransientProcess(internal data for TransferReader)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Handle_Transfer_TransientProcess</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.MapWriter">
<code class="descname">MapWriter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.MapWriter" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the FinderProcess (internal data for TransferWriter)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Handle_Transfer_FinderProcess</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.ModeWriteShape">
<code class="descname">ModeWriteShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.ModeWriteShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Records the current Mode to Write Shapes</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.NewModel">
<code class="descname">NewModel</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.NewModel" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>produces and returns a new Model well conditionned It is produced by the Norm Controller It can be Null (if this function is not implemented)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Interface.html#OCC.Interface.Handle_Interface_InterfaceModel" title="OCC.Interface.Handle_Interface_InterfaceModel">Handle_Interface_InterfaceModel</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.NormAdaptor">
<code class="descname">NormAdaptor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.NormAdaptor" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the norm controller itself</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#OCC.XSControl.Handle_XSControl_Controller" title="OCC.XSControl.Handle_XSControl_Controller">Handle_XSControl_Controller</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.PrintTransferStatus">
<code class="descname">PrintTransferStatus</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.PrintTransferStatus" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Prints the transfer status of a transferred item, as beeing the Mapped n0 &lt;num&gt;, from MapWriter if &lt;wri&gt; is True, or from MapReader if &lt;wri&gt; is False Returns True when done, False else (i.e. num out of range)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>num</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>wri</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – </li>
<li><strong>S</strong> (<em>Handle_Message_Messenger &amp;</em>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.Result">
<code class="descname">Result</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.Result" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the result attached to a starting entity If &lt;mode&gt; = 0, returns Final Result If &lt;mode&gt; = 1, considers Last Result If &lt;mode&gt; = 2, considers Final, else if absent, Last returns it as Transient, if result is not transient returns the Binder &lt;mode&gt; = 10,11,12 idem but returns the Binder itself (if it is not, e.g. Shape, returns the Binder) &lt;mode&gt; = 20, returns the ResultFromModel</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>ent</strong> (<em>Handle_Standard_Transient &amp;</em>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference internal" href="OCC.Standard.html#OCC.Standard.Handle_Standard_Transient" title="OCC.Standard.Handle_Standard_Transient">Handle_Standard_Transient</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.SelectNorm">
<code class="descname">SelectNorm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.SelectNorm" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Selects a Norm defined by its name. A Norm is described and handled by a Controller Returns True if done, False if &lt;normname&gt; is unknown //! A Profile may be set too. If no Profile is provided, the current Profile for this Norm is taken If the asked Profile is not defined for this Norm, it remains in current Profile, returned value is True</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>normname</strong> (<em>char *</em>) – </li>
<li><strong>profile</strong> (<em>char *</em>) – default value is</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.SelectProfile">
<code class="descname">SelectProfile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.SelectProfile" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a Profile as current for the current Norm Returns True if done, False if &lt;profile&gt; is unknown for this norm //! For more infos on Profile, query the Profile of the Controller</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>profile</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.SelectedNorm">
<code class="descname">SelectedNorm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.SelectedNorm" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the name of the last Selected Norm. If none is defined, returns an empty string By default, returns the complete name of the norm If &lt;rsc&gt; is True, returns the short name used for resource</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>rsc</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_False</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">char *</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.SetAllContext">
<code class="descname">SetAllContext</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.SetAllContext" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets the current Context List, as a whole Sets it to the TransferReader</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>context</strong> (<em>Handle_Dico_DictionaryOfTransient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.SetController">
<code class="descname">SetController</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.SetController" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Selects a Norm defined by its Controller itself</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ctl</strong> (<em>Handle_XSControl_Controller &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.SetMapReader">
<code class="descname">SetMapReader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.SetMapReader" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Changes the Map Reader, i.e. considers that the new one defines the relevant read results (forgets the former ones) Returns True when done, False in case of bad definition, i.e. if Model from TP differs from that of Session</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>TP</strong> (<em>Handle_Transfer_TransientProcess &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.SetMapWriter">
<code class="descname">SetMapWriter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.SetMapWriter" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Changes the Map Reader, i.e. considers that the new one defines the relevant read results (forgets the former ones) Returns True when done, False if &lt;FP&gt; is Null</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>FP</strong> (<em>Handle_Transfer_FinderProcess &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.SetModeWriteShape">
<code class="descname">SetModeWriteShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.SetModeWriteShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a mode to transfer Shapes from CasCade to entities of the current norm, which interprets it (see various Controllers) This call form could be later replaced by a more general one</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.SetTransferReader">
<code class="descname">SetTransferReader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.SetTransferReader" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a Transfer Reader, which manages transfers on reading</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>TR</strong> (<em>Handle_XSControl_TransferReader &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.SetVars">
<code class="descname">SetVars</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.SetVars" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>newvars</strong> (<em>Handle_XSControl_Vars &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.TransferReadOne">
<code class="descname">TransferReadOne</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.TransferReadOne" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Commands the transfer of, either one entity, or a list I.E. calls the TransferReader after having analysed &lt;ents&gt; It is cumulated from the last BeginTransfer &lt;ents&gt; is processed by GiveList, hence : - &lt;ents&gt; a Selection : its SelectionResult - &lt;ents&gt; a HSequenceOfTransient : this list - &lt;ents&gt; the Model : in this specific case, all the roots, with no cumulation of former transfers (TransferReadRoots)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ents</strong> (<em>Handle_Standard_Transient &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.TransferReadRoots">
<code class="descname">TransferReadRoots</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.TransferReadRoots" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Commands the transfer of all the root entities of the model i.e. calls TransferRoot from the TransferReader with the Graph No cumulation with former calls to TransferReadOne</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)">int</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.TransferReader">
<code class="descname">TransferReader</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.TransferReader" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Transfer Reader, Null if not set</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#OCC.XSControl.Handle_XSControl_TransferReader" title="OCC.XSControl.Handle_XSControl_TransferReader">Handle_XSControl_TransferReader</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.TransferWriteCheckList">
<code class="descname">TransferWriteCheckList</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.TransferWriteCheckList" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the check-list of last transfer (write) It is recorded in the FinderProcess, but it must be bound with resulting entities (in the resulting file model) rather than with original objects (in fact, their mappers)</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Interface.html#OCC.Interface.Interface_CheckIterator" title="OCC.Interface.Interface_CheckIterator">Interface_CheckIterator</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.TransferWriteShape">
<code class="descname">TransferWriteShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.TransferWriteShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Transfers a Shape from CasCade to a model of current norm, according to the last call to SetModeWriteShape Returns status :Done if OK, Fail if error during transfer, Error if transfer badly initialised</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>shape</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
<li><strong>compgraph</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">IFSelect_ReturnStatus</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.TransferWriter">
<code class="descname">TransferWriter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.TransferWriter" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Transfer Reader, Null if not set</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#OCC.XSControl.Handle_XSControl_TransferWriter" title="OCC.XSControl.Handle_XSControl_TransferWriter">Handle_XSControl_TransferWriter</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_WorkSession.Vars">
<code class="descname">Vars</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.Vars" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">Handle_XSControl_Vars</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.XSControl_WorkSession.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.XSControl_WorkSession.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.XSControl_Writer">
<em class="property">class </em><code class="descname">XSControl_Writer</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Writer" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<ul class="simple">
<li>Creates a Writer from scratch</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>Creates a Writer from scratch, with a norm name which identifie a Controller</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>norm</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></td>
</tr>
</tbody>
</table>
<ul class="simple">
<li>Creates a Writer from an already existing Session If &lt;scratch&gt; is True (D), clears already recorded data</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>WS</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </li>
<li><strong>scratch</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="OCC.XSControl.XSControl_Writer.Model">
<code class="descname">Model</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Writer.Model" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the produced model. Produces a new one if not yet done or if &lt;newone&gt; is True This method allows for instance to edit product or header data before writing</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>newone</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_False</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="OCC.Interface.html#OCC.Interface.Handle_Interface_InterfaceModel" title="OCC.Interface.Handle_Interface_InterfaceModel">Handle_Interface_InterfaceModel</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Writer.PrintStatsTransfer">
<code class="descname">PrintStatsTransfer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Writer.PrintStatsTransfer" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Prints Statistics about Transfer</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>what</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Writer.SetNorm">
<code class="descname">SetNorm</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Writer.SetNorm" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a specific norm to &lt;self&gt; Returns True if done, False if &lt;norm&gt; is not available</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>norm</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)">bool</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Writer.SetWS">
<code class="descname">SetWS</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Writer.SetWS" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Sets a specific session to &lt;self&gt;</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>WS</strong> (<em>Handle_XSControl_WorkSession &amp;</em>) – </li>
<li><strong>scratch</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#bool" title="(in Python v2.7)"><em>bool</em></a>) – default value is Standard_True</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/2/library/constants.html#None" title="(in Python v2.7)">None</a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Writer.TransferShape">
<code class="descname">TransferShape</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Writer.TransferShape" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Transfers a Shape according to the mode</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>sh</strong> (<em>TopoDS_Shape &amp;</em>) – </li>
<li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/2/library/functions.html#int" title="(in Python v2.7)"><em>int</em></a>) – default value is 0</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">IFSelect_ReturnStatus</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Writer.WS">
<code class="descname">WS</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Writer.WS" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the session used in &lt;self&gt;</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#OCC.XSControl.Handle_XSControl_WorkSession" title="OCC.XSControl.Handle_XSControl_WorkSession">Handle_XSControl_WorkSession</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="method">
<dt id="OCC.XSControl.XSControl_Writer.WriteFile">
<code class="descname">WriteFile</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.XSControl_Writer.WriteFile" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Writes the produced model</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>filename</strong> (<em>char *</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">IFSelect_ReturnStatus</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.XSControl_Writer.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.XSControl_Writer.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.new_instancemethod">
<code class="descname">new_instancemethod</code><span class="sig-paren">(</span><em>func</em>, <em>inst</em>, <em>cls</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.new_instancemethod" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="OCC.XSControl.register_handle">
<code class="descname">register_handle</code><span class="sig-paren">(</span><em>handle</em>, <em>base_object</em><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.register_handle" title="Permalink to this definition">¶</a></dt>
<dd><p>Inserts the handle into the base object to
prevent memory corruption in certain cases</p>
</dd></dl>

<dl class="class">
<dt id="OCC.XSControl.xscontrol">
<em class="property">class </em><code class="descname">xscontrol</code><a class="headerlink" href="#OCC.XSControl.xscontrol" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<dl class="staticmethod">
<dt id="OCC.XSControl.xscontrol.Session">
<em class="property">static </em><code class="descname">Session</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span> &#x2192; OCC.XSControl.Handle_XSControl_WorkSession<a class="headerlink" href="#OCC.XSControl.xscontrol.Session" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the WorkSession of a SessionPilot, but casts it as from XSControl : it then gives access to Control &amp; Transfers</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pilot</strong> (<em>Handle_IFSelect_SessionPilot &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#OCC.XSControl.Handle_XSControl_WorkSession" title="OCC.XSControl.Handle_XSControl_WorkSession">Handle_XSControl_WorkSession</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="staticmethod">
<dt id="OCC.XSControl.xscontrol.Vars">
<em class="property">static </em><code class="descname">Vars</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.xscontrol.Vars" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Vars of a SessionPilot, it is brought by Session it provides access to external variables</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pilot</strong> (<em>Handle_IFSelect_SessionPilot &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Handle_XSControl_Vars</td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="attribute">
<dt id="OCC.XSControl.xscontrol.thisown">
<code class="descname">thisown</code><a class="headerlink" href="#OCC.XSControl.xscontrol.thisown" title="Permalink to this definition">¶</a></dt>
<dd><p>The membership flag</p>
</dd></dl>

</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.xscontrol_Session">
<code class="descname">xscontrol_Session</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span> &#x2192; OCC.XSControl.Handle_XSControl_WorkSession<a class="headerlink" href="#OCC.XSControl.xscontrol_Session" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the WorkSession of a SessionPilot, but casts it as from XSControl : it then gives access to Control &amp; Transfers</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pilot</strong> (<em>Handle_IFSelect_SessionPilot &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#OCC.XSControl.Handle_XSControl_WorkSession" title="OCC.XSControl.Handle_XSControl_WorkSession">Handle_XSControl_WorkSession</a></td>
</tr>
</tbody>
</table>
</dd></dl>

<dl class="function">
<dt id="OCC.XSControl.xscontrol_Vars">
<code class="descname">xscontrol_Vars</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#OCC.XSControl.xscontrol_Vars" title="Permalink to this definition">¶</a></dt>
<dd><ul class="simple">
<li>Returns the Vars of a SessionPilot, it is brought by Session it provides access to external variables</li>
</ul>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>pilot</strong> (<em>Handle_IFSelect_SessionPilot &amp;</em>) – </td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">Handle_XSControl_Vars</td>
</tr>
</tbody>
</table>
</dd></dl>

</div>


           </div>
           <div class="articleComments">
            
           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2017, Thomas Paviot.

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  

    <script type="text/javascript">
        var DOCUMENTATION_OPTIONS = {
            URL_ROOT:'./',
            VERSION:'0.18',
            COLLAPSE_INDEX:false,
            FILE_SUFFIX:'.html',
            HAS_SOURCE:  true,
            SOURCELINK_SUFFIX: '.txt'
        };
    </script>
      <script type="text/javascript" src="static/jquery.js"></script>
      <script type="text/javascript" src="static/underscore.js"></script>
      <script type="text/javascript" src="static/doctools.js"></script>

  

  
  
    <script type="text/javascript" src="static/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>